docs: add disclaimer about non-Hamiltonian flows (JOSS reviewer @giovannifereoli, round 2)#800
Merged
Merged
Conversation
- joss/paper.md: append sentence to the Indirect methods bullet in the Software Design section noting that indirect methods are currently limited to Hamiltonian flows (u(x,p)) and that support for non-Hamiltonian flows is under active development - docs/src/manual-flow-ocp.md: add a prominent note admonition at the top of the flow-from-OCP tutorial, before any code example, explaining the same limitation and listing the planned extensions (open-loop u(t) and state-feedback u(x))
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
This PR addresses point 2 of the second-round review by @giovannifereoli for the JOSS submission (openjournals/joss-reviews#10630).
The reviewer asked for a clear disclaimer about the current limitation of indirect methods to Hamiltonian flows, and the planned future support for non-Hamiltonian flows.
Changes
joss/paper.mdExtended the Indirect methods bullet in the Software Design section with a closing sentence:
docs/src/manual-flow-ocp.mdAdded a
noteadmonition at the very top of the flow-from-OCP tutorial, before any code example:This placement is the most visible for users actually working with the
Flowfunction from an OCP.